Summary
Generates menu based on an xml-source or auto generated from a document hierachy.
| Category | AS Menu |
| Version | 1.0 |
| Complies with Xhtml 1.0 / 1.1 rules | No |
| Supported server programming languages | C# Visual Basic.NET |
| Output content type | block |
When to use
This component is typically used to build a menu on a Web site. This component uses an older technique and should only be used for backwards compatibility reasons, for new development you should use Insert menu 3.0 instead. For a more technical comparison between the two menus see the Remarks section.
The component supports cache using session variables.
Programming interface
Parameters
- MenuName
- Name of the menu. Must be unique in the Web site.
- UseSession
- Cache the menu using session variables. The menu is cached once per user. Should only be used when security is set on menu items, which renders different menus for different users.
- DocId
- An identifier to the root document that acts as a source of the menu. This value is ignored if HttpSource or StringSource is set.
- PTId
- An optional presentation template id that will be included in every link in the menu.
- HttpSource
- An http xml source to use instead of a document hierarchy.
- StringSource
- An xml string to use as the meny source. This value is ignored if HttpSource is set.
- VerticalMenu
- Render the menu vertically.
- ClickableRoots
- Check this to navigate when user clicks on a root document.
- Target
- Indicates the default target for all links in the menu.
- MenuHeaderLowlightColor
- The color for the lowlight menu header
- MenuHeaderHighlightColor
- The color for the highlight menu header
- MenuHeaderLowlightTextColor
- The text color for the lowlight menu header
- MenuHeaderHighlightTextColor
- The text color highlight menu header
- MenuHeaderWidth
- The width in pixels of the table for the menu header
- MenuHeaderPaddingWidth
- The left and right cell padding for the menu header
- MenuHeaderPaddingHeight
- The top and bottom cell padding for the menu header
- MenuHeaderClassName
- A CSS class to use with the menu header
- MenuItemLowlightColor
- The color for the lowlighted menu items
- MenuItemHighlightColor
- The color for highlighted menu items
- MenuItemLowlightTextColor
- The text color for the lowlighted menu items
- MenuItemHighlightTextColor
- The text color for the highlighted menu items
- MenuItemWidth
- The width, in pixels, for each menu item
- MenuItemBorder
- The width, in pixels, for the border of each menu item
- MenuItemBorderColor
- The color for the border of the menu items
- MenuItemPaddingRight
- The right padding for each menu item
- MenuItemPaddingTop
- The top padding for each menu item
- MenuItemPadding
- The padding for each menu item
- MenuItemClassName
- A CSS class to be applied to each menu item
- MenuItemsContainerClassName
- A CSS class to be applied for the menu item container
Remarks
The difference between the Insert menu 3.0 and Insert menu 2.0 is that the former uses a list with UL / LI elements styled by CSS while the latter uses a TABLE element with JavaScript. Insert menu 2.0 should only be used for backward compatibility reasons.
General remarks with menu components
All menu driven components uses the Content Studio menu API:s and hierarchy document structures. The caller must have BROWSE permission to all items displayed and every item must be live and published. When the menu renders Content Studio traverses through the entire document tree and whenever there is a document that is not available to the caller the traverse operation breaks at this point. This have the effect that any object that is a child of a unavailable document will be left out since the tree is broken at that point.